﻿//////////////////////////////////////////////////////////////////////////////
//
//  Copyright © 1998-2024 Glodon Company Limited.  All rights reserved.
//
//  Use of this software is subject to the terms of the Glodon license
//  agreement provided at the time of installation or download, or which
//  otherwise accompanies this software in either electronic or hard copy form.  
//
//////////////////////////////////////////////////////////////////////////////


#pragma once
#include "chrono"
#include "GcmpModelInterface.h"
#include "IObject.h"

namespace gcmp
{
    class IDocument;
    /// \brief 监控元素对象改变的观察类
    ///
    /// 监听和管理所有元素对象变化数据，此类为访问内部数据类，不允许从此类中派生。
    class GCMP_MODEL_INTERFACE_EXPORT IElementsChangeObserver : public IObject
    {
        DEFINE_CAST_DERIVED(gcmp::IElementsChangeObserver, gcmp::IObject);
    public:
        /// \brief 创建一个监控元素对象改变的观察实例
        /// \return 元素对象改变的观察实例
        static OwnerPtr<IElementsChangeObserver> Create();
        
        /// \brief 注册元素对象改变的观察实例到指定文档上
        /// 
        /// 只有在未注册的文档上才能注册成功，否则注册失败。
        /// 可以通过 \see GetRegisteredDocument() 是否为空来判断是否已注册。
        /// 如果已注册，可以通过 \see UnRegister() 来取消注册，再注册到想要的文档上。
        /// \param pDocument 需要注册的文档对象
        /// \return true-注册成功，false-注册失败
        virtual bool Register(IDocument* pDocument) = 0;

        /// \brief 取消注册元素对象改变的观察实例，所有的改变会被清空。
        virtual void Unregister() = 0;

        /// \brief 获取所注册的文档对象
        /// \return 文档对象。如果未注册则为空。
        virtual const IDocument* GetRegisteredDocument() const = 0;

        /// \brief 得到元素对象改变数据
        /// \param pAdded 增加元素对象集合，指针有效才会输出数据，输入的集合原有的内容不会被清除
        /// \param pDeleted 删除元素对象集合，指针有效才会输出数据，输入的集合原有的内容不会被清除
        /// \param pUpdated 改变元素对象集合，指针有效才会输出数据，输入的集合原有的内容不会被清除
        /// \return void
        virtual void GetChangedElementIds(
            std::vector<ElementId> * pAdded,
            std::vector<ElementId> * pDeleted,
            std::vector<ElementId> * pUpdated
        ) const = 0;

        /// \brief 得到元素对象改变数据
        /// \param pAdded 增加元素对象集合，指针有效才会输出数据，输入的集合原有的内容不会被清除
        /// \param pDeleted 删除元素对象集合，指针有效才会输出数据，输入的集合原有的内容不会被清除
        /// \param pUpdated 改变元素对象集合，指针有效才会输出数据，输入的集合原有的内容不会被清除
        /// \param pLoaded 加载元素对象集合，指针有效才会输出数据，输入的集合原有的内容不会被清除
        /// \param pUnloaded 卸载元素对象集合，指针有效才会输出数据，输入的集合原有的内容不会被清除
        /// \return void
        virtual void GetChangedElementIds(
            std::vector<ElementId> * pAdded,
            std::vector<ElementId> * pDeleted,
            std::vector<ElementId> * pUpdated,
            std::vector<ElementId> * pLoaded,
            std::vector<ElementId> * pUnloaded
        ) const = 0;

        /// \brief 得到元素对象改变数据
        /// \param pAdded 增加元素对象集合，指针有效才会输出数据，输入的集合原有的内容不会被清除
        /// \param pDeleted 删除元素对象集合，指针有效才会输出数据，输入的集合原有的内容不会被清除
        /// \param pUpdated 改变元素对象集合，指针有效才会输出数据，输入的集合原有的内容不会被清除
        /// \param pLoaded 加载元素对象集合，指针有效才会输出数据，输入的集合原有的内容不会被清除
        /// \param pUnloaded 卸载元素对象集合，指针有效才会输出数据，输入的集合原有的内容不会被清除
        /// \param pModifiedElementTime 修改元素对象集合，指针有效才会输出数据，输入的集合原有的内容会被清除
        /// \return void
        virtual void GetChangedElementIds(
            std::vector<ElementId>* pAdded,
            std::vector<ElementId>* pDeleted,
            std::vector<ElementId>* pUpdated,
            std::vector<ElementId>* pLoaded,
            std::vector<ElementId>* pUnloaded,
            std::map<ElementId, std::chrono::system_clock::duration>* pModifiedElementTime
        ) const = 0;

        /// \brief 得到元素对象改变数据
        /// \param pAdded 增加元素对象集合，指针有效才会输出数据，输入的集合原有的内容不会被清除
        /// \param pDeleted 删除元素对象集合，指针有效才会输出数据，输入的集合原有的内容不会被清除
        /// \param pUpdated 改变元素对象集合，指针有效才会输出数据，输入的集合原有的内容不会被清除
        /// \param pLoaded 加载元素对象集合，指针有效才会输出数据，输入的集合原有的内容不会被清除
        /// \param pUnloaded 卸载元素对象集合，指针有效才会输出数据，输入的集合原有的内容不会被清除
        /// \param pModifiedElementTime 修改元素对象集合，指针有效才会输出数据，输入的集合原有的内容会被清除
        /// \param pModifiedElementInfo 修改元素对象信息集合，指针有效才会输出数据，输入的集合原有的内容会被清除
        /// \return void
        virtual void GetChangedElementIds(
            std::vector<ElementId>* pAdded,
            std::vector<ElementId>* pDeleted,
            std::vector<ElementId>* pUpdated,
            std::vector<ElementId>* pLoaded,
            std::vector<ElementId>* pUnloaded,
            std::map<ElementId, std::chrono::system_clock::duration>* pModifiedElementTime,
            std::map<ElementId, std::wstring>* pModifiedElementInfo
        ) const = 0;
        
        /// \brief 清除所有缓存中的改变数据
        /// \return void
        virtual void ClearAllChanges() = 0;

        virtual void SetIsNeedRecordElementChangeTimeInTransaction(bool isNeed) =0;

        virtual void StartTransactionRecord() =0;

        virtual void StopTransactionRecord() =0;

        virtual void ClearTransactionChangeRecords() = 0;
    };
}






